home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / BOX.HDR < prev    next >
Text File  |  1994-04-25  |  6KB  |  134 lines
  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _Box( nFRow, nFCol, nTRow, nTCol, nBox_Type, nLabel, cLabel_Txt) --> NIL
  8.  
  9. PARAMETERS:
  10.  
  11. nFRow      : Screen Coordinates of Box
  12. nFCol      : ""
  13. nTRow      : ""
  14. nTCol      : ""
  15. nBox_Type  : Numeric 1, 2, 3, 4 (See KLIPPER.CH for #defines)
  16. nLabel     : Numeric 1, 4, 5    (See KLIPPER.CH for #defines)
  17. cLabel_Txt : Box Label Text
  18.  
  19. SHORT:
  20.  
  21. Draw a box with a "shadow."
  22.  
  23. DESCRIPTION:
  24.  
  25. _Box() draws a box, with shadow.  Optionally, you may specify which type of
  26. box border you want, and several types of border labels.
  27.  
  28. The _Box() function calls _PopBox() to provide the "exploding" effect, and
  29. passes the nBox_Type parameter.
  30.  
  31. nBox_Type (BOX TYPES):
  32.  
  33. (Default)
  34.   1         2         3         4           5           6
  35.  
  36. ┌────┐   ╓─────╖   ╒═════╕   ╔══════╗    █▀▀▀▀▀▀▀▀█     NO BORDER
  37. │    │   ║     ║   │     │   ║      ║    ▌        ▐
  38. │    │   ║     ║   │     │   ║      ║    ▌        ▐
  39. └────┘   ╙─────╜   ╘═════╛   ╚══════╝    █▄▄▄▄▄▄▄▄█
  40.  
  41. NOTE:
  42.  
  43. The shadow created by _Box() can be one of two choices.  The shadow can be
  44. one character wide or two characters wide.  Two characters wide makes the
  45. shadow area larger and gives the impression that the box is "higher" off the
  46. desktop area.  This option is not passed as a parameter but is controlled by
  47. a variable called KBOXHIGH.  To force the Box() "high", create a PUBLIC or
  48. PRIVATE at the top of your program, or anywhere else so long as it is in
  49. scope when the _Box() function is called, and assign it a TRUE value:
  50.  
  51. PUBLIC KBOXHIGH := .T.
  52.  
  53. This causes the _Box() shadow to be two characters wide giving the appearance
  54. of height.  If this variable is not declared, or is not in scope at the time
  55. the _Box() function is called, then the default shadow width is one character
  56. or "low".
  57.  
  58. EXAMPLE:
  59.  
  60. _Box(5,10,15,70,THICK,LABEL_ARROWS_RIGHT,'This is a label')
  61.  
  62. Other Label Types (In the following, the ^ and v characters are replaced by
  63. chr(25) and chr(24) on the screen.  Here they are ^ and v only to satisfy a
  64. word processor's obsessive/compulsive habit of stripping those characters
  65. out).  All boxes are of type 4 (BOXDOUBLE):
  66.  
  67.  
  68. Example 1           ╔══════════════════════════════════════════════════╗
  69. Box Type 4          ║                                                  ║
  70. NO LABEL TYPE       ║                                                  ║
  71.                     ║     Label Type NOT SPECIFIED (DEFAULT)           ║
  72.                     ║                                                  ║
  73.                     ║     NO HELP KEY on Bottom AND NO Arrows          ║
  74.                     ║                                                  ║
  75.                     ║                                                  ║
  76.                     ╚══════════════════════════════════════════════════╝
  77.  
  78.  
  79. Example 2           ╔══════════════════════════════════════════════════╗
  80. Box Type 4          ║                                                  ║
  81. Label Type 1        ║                                                  ║
  82.                     ║     Label Type 1                                 ║
  83.                     ║                                                  ║
  84.                     ║     Key Help on Bottom no Arrows                 ║
  85.                     ║                                                  ║
  86.                     ║                                                  ║
  87.                     ╚═╣ ^v Move, ╛ Select ╠═══════════════════════════╝
  88.  
  89.  
  90.  
  91.  
  92. Example 3           ╔══════════════════════════════════════════════════╗
  93. Box Type 4          ║                                                  ^
  94. Label Type 4        ║                                                  ║
  95.                     ║     Label Type 4                                 ║
  96.                     ║                                                  ║
  97.                     ║     Key Help on Bottom AND arrows on RIGHT       ║
  98.                     ║                                                  ║
  99.                     ║                                                  v
  100.                     ╚═╣ ^v Move, ╛ Select ╠═══════════════════════════╝
  101.  
  102.  
  103.  
  104.  
  105. Example 4           ╔══════════════════════════════════════════════════╗
  106. Box Type 4          ^                                                  ║
  107. Label Type 5        ║                                                  ║
  108.                     ║     Label Type 4                                 ║
  109.                     ║                                                  ║
  110.                     ║     Key Help on Bottom AND arrows on LEFT        ║
  111.                     ║                                                  ║
  112.                     v                                                  ║
  113.                     ╚═╣ ^v Move, <╛ Select ╠═══════════════════════════╝
  114.  
  115.  
  116. Example using all defaults:
  117.  
  118.     _Box(10,10,12,40,4,5)
  119.  
  120.  
  121. Result: A box appears on the screen at coordinates: 10,10,12,40 that
  122. looks similar to Example 4 above, with
  123. shadow.
  124.  
  125. Example using all parameters:
  126.  
  127.     _Box(5,10,15,70,THICK,LABEL_ARROWS_RIGHT,'This is a label')
  128.  
  129. Result: A shadow box, at the given coordinates, with a thick (Type 5) border,
  130. with up and down arrows on the RIGHT side and the label "This is a label"
  131. on the bottom, is drawn.
  132.  
  133. ******************************************************************************/
  134.